<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>vphy: Main Page</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">vphy
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li class="current"><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('index.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<div class="title">vphy Documentation</div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>This is main header file of the Xilinx Video PHY Controller driver<b>Video PHY Controller Overview</b></p>
<p>The PHY is intended to simplify the use of serial transceivers and adds domain-specific configurability. The Video PHY Controller IP is not intended to be used as a stand alone IP and must be used with Xilinx Video MACs such as HDMI 1.4/2.0 Transmitter/Receiver Subsystems and DisplayPort TX/RX Subsystems. The core enables simpler connectivity between MAC layers for TX and RX paths. However, it is still important to understand the behavior, usage, and any limitations of the transceivers. See the device specific transceiver user guide for details.</p>
<p><b>Video PHY Controller Driver Features</b></p>
<p>Video PHY Controller driver supports following features</p>
<ul>
<li>Xilinx DisplayPort and HDMI MAC IPs</li>
<li>GTXE2, GTPE2, GTHE2, GTHE3, GTHE4 and GTYE4 GT types</li>
<li>HDMI:</li>
<li>2 or 4 pixel-wide video interface</li>
<li>8/10/12/16 bits per component</li>
<li>RGB &amp; YCbCr color space</li>
<li>Up to 4k2k 60Hz resolution at both Input and Output interface</li>
</ul>
<pre>
MODIFICATION HISTORY:</pre><pre>Ver   Who  Date     Changes
</p>
<hr/>
<p>
1.0   als  10/19/15 Initial release.
1.1   gm   02/01/16 Added EAST, WEST, PLL0 and PLL1 definitions
                    for GTPE2.
                    Added more events to XVphy_LogEvent definitions
                    Added TxBufferBypass in <a class="el" href="struct_x_vphy___config.html" title="This typedef contains configuration information for the Video PHY core. ">XVphy_Config</a> structure
                    Added XVphy_SetDefaultPpc and XVphy_SetPpc functions
      als           Added XVphy_GetLineRateHz function.
1.2   gm            Added HdmiFastSwitch in <a class="el" href="struct_x_vphy___config.html" title="This typedef contains configuration information for the Video PHY core. ">XVphy_Config</a>
                    Changed EffectiveAddr datatype in XVphy_CfgInitialize
                      to UINTPTR
                    Added log events for debugging
1.2   gm   11/11/19 Added TransceiverWidth in <a class="el" href="struct_x_vphy___config.html" title="This typedef contains configuration information for the Video PHY core. ">XVphy_Config</a>
1.4   gm   29/11/16 Moved internally used APIs to <a class="el" href="xvphy__i_8c.html" title="Contains generic APIs that are locally called or used within the VPHY driver. ">xvphy_i.c</a>/h
                    Added preprocessor directives for sw footprint reduction
                    Made debug log optional (can be disabled via makefile)
                    Added ERR_IRQ type_defs (not for official use for
                      Xilinx debugging)
                    Added transceiver width, AXIlite clk frequency and
                      err_irq in <a class="el" href="struct_x_vphy___config.html" title="This typedef contains configuration information for the Video PHY core. ">XVphy_Config</a>
1.5   gm   08/05/17 Added DrpClkFreq in <a class="el" href="struct_x_vphy___config.html" title="This typedef contains configuration information for the Video PHY core. ">XVphy_Config</a>
1.6   gm   06/08/17 Added XVPHY_LOG_EVT_HDMI20_ERR &amp;
                      XVPHY_LOG_EVT_DRU_CLK_ERR XVphy_LogEvent enum
                    Added intr events for TX and RX MMCM lock
                    Marked XVphy_DrpWrite and XVphy_DrpRead as deprecated
                    Added XVphy_SetErrorCallback API
                    Changed ClkOutxDiv declaration to u16
                    Marked XVphy_HdmiInitialize deprecated and replaced by
                       XVphy_Hdmi_CfgInitialize
1.7   gm   13/09/17 Added GTYE4 support
                    Added XVphy_SetPolarity, XVphy_SetPrbsSel and
                       XVphy_TxPrbsForceError APIs
1.8   gm   05/14/18 Updated CDR values for DP in <a class="el" href="xvphy__gtye4_8c.html" title="Contains a minimal set of functions for the XVphy driver that allow access to all of the Video PHY co...">xvphy_gtye4.c</a>
                    Removed XVphy_DrpWrite and XVphy_DrpRead APIs
           23/07/18 Added APIs XVphy_SetTxVoltageSwing and
                      XVphy_SetTxPreEmphasis from <a class="el" href="xvphy__i_8c.html" title="Contains generic APIs that are locally called or used within the VPHY driver. ">xvphy_i.c</a>/h
                    Added XVphy_SetTxPostCursor API
1.9   gm   14/05/18 Added XVphy_SetRxLpm from <a class="el" href="xvphy__i_8c.html" title="Contains generic APIs that are locally called or used within the VPHY driver. ">xvphy_i.c</a>/.h
                    Removed deprecated XVphy_HdmiInitialize API
</pre> </div></div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
